Skip to main content

Leaderboard Entities

These entities are used by the Leaderboard adapter and encapsulate data objects used by the Epicenter Leaderboard API.

Score​

The Score interface describes a score entry in the leaderboard.

Properties​

  • name (string): The name of the performance metric measured by the score (e.g., "total", "extraCredit").
  • quantity (number): The numeric value of the score.

Tag​

The Tag interface describes a label-content pair.

Properties​

  • label (string): The tag’s key or category (e.g., "role", "department").
  • content (string): The value associated with the label (e.g., "doctor", "math").

Here’s the regenerated Markdown documentation in the same format and style as your example:

Leaderboard​

The Leaderboard interface describes a leaderboard entry.

Properties​

  • lastUpdated (Date): The timestamp indicating when the leaderboard entry was last updated.
  • scores (Score[]): An array of Score objects representing individual player or team scores within the leaderboard.
  • scope ({ userKey?: string } & GenericScope): The scope of the leaderboard. A GenericScope object can be combined with a userKey string to form user specific scope.
  • collection (string): The collection name or identifier associated with this leaderboard entry.
  • tags (Tag[]): A list of Tag objects providing metadata or categorization for the leaderboard entry.